Skip to content

Add OAuthConsent and useOAuthConsent docs#3315

Merged
jfoshee merged 34 commits into
mainfrom
rob/oauth-consent-docs
Jun 22, 2026
Merged

Add OAuthConsent and useOAuthConsent docs#3315
jfoshee merged 34 commits into
mainfrom
rob/oauth-consent-docs

Conversation

@wobsoriano

@wobsoriano wobsoriano commented Apr 23, 2026 •
edited by SarahSoutoul
Loading

Copy link
Copy Markdown
Member

Waiting on

🔎 Previews:

What does this solve? What changed?

We will now allow C1s to configure a custom OAuth consent page where they can use a custom hook, or the new drop-in <OAuthConsent /> component

Deadline

  • No rush

Other resources

@vercel

vercel Bot commented Apr 23, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-docs Ready Ready Preview Jun 22, 2026 7:52pm

Request Review

@wobsoriano wobsoriano marked this pull request as ready for review May 1, 2026 17:11
@wobsoriano wobsoriano requested a review from a team as a code owner May 1, 2026 17:11
@SarahSoutoul

SarahSoutoul commented May 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@wobsoriano have submitted a docs review with some minor changes:

  • Replaced instances of "signed-in users" with "authenticated users".
  • Rephrased some of the <OAuthConsent /> component intro to make it a bit more smooth.
  • Changed some of the props descriptions for the <OAuthConsent /> component to align with rest of the docs.

Let me know what you think, and left some comments too!

SarahSoutoul
SarahSoutoul reviewed May 4, 2026
View reviewed changes
Comment thread docs/reference/hooks/use-oauth-consent.mdx Outdated
SarahSoutoul
SarahSoutoul reviewed May 4, 2026
View reviewed changes
Comment thread docs/reference/components/authentication/oauth-consent.mdx
SarahSoutoul
SarahSoutoul reviewed May 4, 2026
View reviewed changes
Comment thread docs/reference/hooks/use-oauth-consent.mdx Outdated
@SarahSoutoul

SarahSoutoul commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

right now, the callout about setting the referrer policy is in the intro section for the component, but the returns section for the hook - was there any specific reasoning behind having it in the returns section for the hook? imo, it should go in either the intro paragraph/section or the example section! but let's be consistent between the component and hook pages :)

oh good catch, moved it to the intro section to match the component. Thanks!

Thank you @wobsoriano! Have approved now - whenever everything is released and ready, feel free to remove the "do not merge" label and merge this PR.

@SarahSoutoul SarahSoutoul mentioned this pull request Jun 1, 2026
Closed
@jescalan jescalan mentioned this pull request Jun 1, 2026
Merged
@jescalan @SarahSoutoul
Add custom OAuth consent security guide (#3413)
73a9d6e 
Co-authored-by: Sarah Soutoul <sarah@clerk.dev>
@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

⚠️ TypeDoc files detected in this PR

This PR modifies files in the 'clerk-typedoc/' folder. These files are auto-generated from the clerk/javascript repository and should not be edited directly.

To make changes to TypeDoc documentation:

  1. 🔄 Make your changes in the appropriate files in the clerk/javascript repository.
  2. 🚀 The TypeDoc documentation will be pulled through to this repository via a CI action.

Thanks for contributing! 🙏

@SarahSoutoul SarahSoutoul force-pushed the rob/oauth-consent-docs branch from ec8d2fe to 3a65694 Compare June 22, 2026 15:15
@jfoshee jfoshee mentioned this pull request Jun 22, 2026
Merged
9 tasks
jfoshee added a commit to clerk/javascript that referenced this pull request Jun 22, 2026
@jfoshee
docs: add link replacement for OAuth Application
131d2e0 
Currently the link to `OAuthApplicationNamespace` at https://clerk.com/docs/js-frontend/reference/objects/clerk#oauthapplication routes to a 404

In conjunction with the pending docs PR:
clerk/clerk-docs#3315
This will fix that link to point at the new page at `reference/types/oauth-application`
SarahSoutoul
SarahSoutoul reviewed Jun 22, 2026
View reviewed changes
Comment thread docs/guides/configure/auth-strategies/oauth/custom-consent-page.mdx Outdated
SarahSoutoul
SarahSoutoul reviewed Jun 22, 2026
View reviewed changes
Comment thread docs/reference/hooks/use-oauth-consent.mdx
@SarahSoutoul

SarahSoutoul commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

@jfoshee @wobsoriano have pushed a final docs review that should be self explanatory. Feel free to remove the "do not merge" label and merge when ready!

I'll take care of the sibling Typedoc PR: #3456

@SarahSoutoul SarahSoutoul mentioned this pull request Jun 22, 2026
Closed
@jfoshee jfoshee merged commit 269a406 into main Jun 22, 2026
8 of 9 checks passed
@jfoshee jfoshee deleted the rob/oauth-consent-docs branch June 22, 2026 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SarahSoutoul SarahSoutoul SarahSoutoul approved these changes
+2 more reviewers
@jfoshee jfoshee jfoshee left review comments
@alexisintech alexisintech alexisintech approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@SarahSoutoul SarahSoutoul

@alexisintech alexisintech

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@wobsoriano @SarahSoutoul @alexisintech @jfoshee @jescalan